package com.hao.study.config;

import com.github.xiaoymin.knife4j.spring.annotations.EnableKnife4j;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.oas.annotations.EnableOpenApi;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.Contact;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;

/**
 * @author: author
 * @description:
 * @date: 2024/6/14 13:15
 * @version: 1.0
 */
@EnableKnife4j
@Configuration
@EnableOpenApi
public class Swagger3Config {
    /**
     * 配置Swagger的Docket Bean。
     * 该方法用于创建并配置Swagger的Docket对象，以定义如何生成API文档。
     *
     * @return Docket对象，用于进一步配置Swagger文档的生成。
     */
    @Bean
    public Docket coreApiConfig(){
        // 创建一个Docket对象，指定文档类型为OAS 3.0
        return new Docket(DocumentationType.OAS_30)
                // 配置API信息，通过调用getApiInfo()方法获取
                .apiInfo(getApiInfo())
                // 设置API分组名称
                .groupName("apis")
                // 选择要包含的API，这里选择com.hao.study.controller包下的所有控制器
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.hao.study.controller"))
                // 选择所有路径作为要文档化的API路径
                .paths(PathSelectors.any())
                // 根据选择和配置构建Docket对象
                .build();
    }

    /**
     * 构建并返回ApiInfo对象。
     * 该对象用于配置Swagger文档的基本信息。
     *
     * @return ApiInfo对象，包含Swagger文档的标题、描述、版本等信息。
     */
    private ApiInfo getApiInfo(){
        // 使用ApiInfoBuilder来逐步构建ApiInfo对象
        return new ApiInfoBuilder()
                // 设置文档的标题
                .title("api文档")
                // 设置文档的描述
                .description("管理系统接口描述")
                //  设置作者
                .contact(new Contact("王国昊","","994015132@qq.com"))
                // 设置文档的版本
                .version("1.0")
                // 完成构建并返回ApiInfo对象
                .build();
    }
}
